Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bf release #16

Merged
merged 16 commits into from
Aug 24, 2024
Merged

Bf release #16

merged 16 commits into from
Aug 24, 2024

Conversation

jburel
Copy link
Member

@jburel jburel commented Aug 20, 2024

Add Bio-Formats release instruction

@jburel jburel requested a review from dgault August 20, 2024 13:59
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Show resolved Hide resolved
Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nitpicks but overall reads well. A few items from the internal release process were not ported to this page:

  • the addition of external contributors
  • the update of the Bio-Formats examples
  • the testing instructions for the artifacts

docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
@jburel
Copy link
Member Author

jburel commented Aug 22, 2024

I feel that the testing part is a bit out of place and late in the release process. The rest has been adjusted. Happy to discuss

Copy link
Member

@dgault dgault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small changes suggested, otherwise the big missing piece are the tetsing instructions

docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Outdated Show resolved Hide resolved
docs/bioformats-release-process.rst Show resolved Hide resolved
@jburel
Copy link
Member Author

jburel commented Aug 22, 2024

A few small changes suggested, otherwise the big missing piece are the tetsing instructions

I feel that this should be done before the release process cf. my previous comment
In that case, we need a retraction step in case an error happens during the testing

@joshmoore
Copy link
Member

General 👍. I'll point out though that I had a bit of trouble finding the new page under "Component release":

image

Not for this PR, but we might consider reordering the left-side menu as we add more items.

@jburel
Copy link
Member Author

jburel commented Aug 23, 2024

Testing section added @dgault with retractions steps

Copy link
Member

@dgault dgault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the addition of the testing section this looks good to me

Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two inline comments for possible follow-up actions. Otherwise, this reads well to me and captures all essential aspects of the release process

---------------------

To test the artifacts published,
- Test the `bio-formats-command-line-tools <https://docs.openmicroscopy.org/internal/testing_scenarios/GeneralRelease.html#bio-formats-command-line-tools>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As these hyperlinks require (UoD?) authentication, I suspect a follow-up action might be to extract these testing scenarios to a public page?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is.
This is something that we need to extract. we faced the same issue during the Django upgrade testing

$ mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false
$ mvn versions:set-property -Dproperty=formats-gpl.version -DnewVersion=x.y.z -DgenerateBackupPoms=false

Bump the ``version`` and ``formats-gpl`` in :file:`build.gradle`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note with ome/bio-formats-examples#128 the proposal is to only have formats-bsd as a depedency

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will have to be adjusted accordingly when the example PR is merged

@jburel jburel merged commit 79ae22c into ome:master Aug 24, 2024
1 check passed
@sbesson sbesson mentioned this pull request Aug 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants